home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 15 / CU Amiga Magazine's Super CD-ROM 15 (1997)(EMAP Images)(GB)[!][issue 1997-10].iso / CUCD / Graphics / Ghostscript / source / gsjpglib.h < prev    next >
C/C++ Source or Header  |  1995-04-05  |  38KB  |  939 lines
  1. /*
  2.  * jpeglib.h
  3.  *
  4.  * Copyright (C) 1991-1994, Thomas G. Lane.
  5.  * This file is part of the Independent JPEG Group's software.
  6.  * For conditions of distribution and use, see the accompanying README file.
  7.  * Modified by L. Peter Deutsch 4-4-1995 for use with Ghostscript.
  8.  * (Edits marked with 'lpd' below.)
  9.  *
  10.  * This file defines the application interface for the JPEG library.
  11.  * Most applications using the library need only include this file,
  12.  * and perhaps jerror.h if they want to know the exact error codes.
  13.  */
  14.  
  15. #ifndef JPEGLIB_H
  16. #define JPEGLIB_H
  17.  
  18. /*
  19.  * First we include the configuration files that record how this
  20.  * installation of the JPEG library is set up.  jconfig.h can be
  21.  * generated automatically for many systems.  jmorecfg.h contains
  22.  * manual configuration options that most people need not worry about.
  23.  */
  24.  
  25. #ifndef JCONFIG_INCLUDED    /* in case jinclude.h already did */
  26. #include "jconfig.h"        /* widely used configuration options */
  27. #endif
  28. #include "jmorecfg.h"        /* seldom changed options */
  29.  
  30.  
  31. /* Version ID for the JPEG library.
  32.  * Might be useful for tests like "#if JPEG_LIB_VERSION >= 60".
  33.  */
  34.  
  35. #define JPEG_LIB_VERSION  51    /* Version 5a */
  36.  
  37.  
  38. /* Various constants determining the sizes of things.
  39.  * All of these are specified by the JPEG standard, so don't change them
  40.  * if you want to be compatible.
  41.  */
  42.  
  43. #define DCTSIZE            8    /* The basic DCT block is 8x8 samples */
  44. #define DCTSIZE2        64    /* DCTSIZE squared; # of elements in a block */
  45. #define NUM_QUANT_TBLS      4    /* Quantization tables are numbered 0..3 */
  46. #define NUM_HUFF_TBLS       4    /* Huffman tables are numbered 0..3 */
  47. #define NUM_ARITH_TBLS      16    /* Arith-coding tables are numbered 0..15 */
  48. #define MAX_COMPS_IN_SCAN   4    /* JPEG limit on # of components in one scan */
  49. #define MAX_SAMP_FACTOR     4    /* JPEG limit on sampling factors */
  50. /* Following values changed by lpd for Adobe compatibility. */
  51. #define MAX_BLOCKS_IN_MCU   64    /* JPEG limit on # of blocks in an MCU */
  52.  
  53.  
  54. /* This macro is used to declare a "method", that is, a function pointer.
  55.  * We want to supply prototype parameters if the compiler can cope.
  56.  * Note that the arglist parameter must be parenthesized!
  57.  */
  58.  
  59. #ifdef HAVE_PROTOTYPES
  60. #define JMETHOD(type,methodname,arglist)  type (*methodname) arglist
  61. #else
  62. #define JMETHOD(type,methodname,arglist)  type (*methodname) ()
  63. #endif
  64.  
  65.  
  66. /* Data structures for images (arrays of samples and of DCT coefficients).
  67.  * On 80x86 machines, the image arrays are too big for near pointers,
  68.  * but the pointer arrays can fit in near memory.
  69.  */
  70.  
  71. typedef JSAMPLE FAR *JSAMPROW;    /* ptr to one image row of pixel samples. */
  72. typedef JSAMPROW *JSAMPARRAY;    /* ptr to some rows (a 2-D sample array) */
  73. typedef JSAMPARRAY *JSAMPIMAGE;    /* a 3-D sample array: top index is color */
  74.  
  75. typedef JCOEF JBLOCK[DCTSIZE2];    /* one block of coefficients */
  76. typedef JBLOCK FAR *JBLOCKROW;    /* pointer to one row of coefficient blocks */
  77. typedef JBLOCKROW *JBLOCKARRAY;        /* a 2-D array of coefficient blocks */
  78. typedef JBLOCKARRAY *JBLOCKIMAGE;    /* a 3-D array of coefficient blocks */
  79.  
  80. typedef JCOEF FAR *JCOEFPTR;    /* useful in a couple of places */
  81.  
  82.  
  83. /* Types for JPEG compression parameters and working tables. */
  84.  
  85.  
  86. /* DCT coefficient quantization tables. */
  87.  
  88. typedef struct {
  89.   /* This field directly represents the contents of a JPEG DQT marker.
  90.    * Note: the values are always given in zigzag order.
  91.    */
  92.   UINT16 quantval[DCTSIZE2];    /* quantization step for each coefficient */
  93.   /* This field is used only during compression.  It's initialized FALSE when
  94.    * the table is created, and set TRUE when it's been output to the file.
  95.    * You could suppress output of a table by setting this to TRUE.
  96.    * (See jpeg_suppress_tables for an example.)
  97.    */
  98.   boolean sent_table;        /* TRUE when table has been output */
  99. } JQUANT_TBL;
  100.  
  101.  
  102. /* Huffman coding tables. */
  103.  
  104. typedef struct {
  105.   /* These two fields directly represent the contents of a JPEG DHT marker */
  106.   UINT8 bits[17];        /* bits[k] = # of symbols with codes of */
  107.                 /* length k bits; bits[0] is unused */
  108.   UINT8 huffval[256];        /* The symbols, in order of incr code length */
  109.   /* This field is used only during compression.  It's initialized FALSE when
  110.    * the table is created, and set TRUE when it's been output to the file.
  111.    * You could suppress output of a table by setting this to TRUE.
  112.    * (See jpeg_suppress_tables for an example.)
  113.    */
  114.   boolean sent_table;        /* TRUE when table has been output */
  115. } JHUFF_TBL;
  116.  
  117.  
  118. /* Basic info about one component (color channel). */
  119.  
  120. typedef struct {
  121.   /* These values are fixed over the whole image. */
  122.   /* For compression, they must be supplied by parameter setup; */
  123.   /* for decompression, they are read from the SOF marker. */
  124.   int component_id;        /* identifier for this component (0..255) */
  125.   int component_index;        /* its index in SOF or cinfo->comp_info[] */
  126.   int h_samp_factor;        /* horizontal sampling factor (1..4) */
  127.   int v_samp_factor;        /* vertical sampling factor (1..4) */
  128.   int quant_tbl_no;        /* quantization table selector (0..3) */
  129.   /* These values may vary between scans. */
  130.   /* For compression, they must be supplied by parameter setup; */
  131.   /* for decompression, they are read from the SOS marker. */
  132.   int dc_tbl_no;        /* DC entropy table selector (0..3) */
  133.   int ac_tbl_no;        /* AC entropy table selector (0..3) */
  134.   
  135.   /* Remaining fields should be treated as private by applications. */
  136.   
  137.   /* These values are computed during compression or decompression startup: */
  138.   /* Component's size in DCT blocks.
  139.    * Any dummy blocks added to complete an MCU are not counted; therefore
  140.    * these values do not depend on whether a scan is interleaved or not.
  141.    */
  142.   JDIMENSION width_in_blocks;
  143.   JDIMENSION height_in_blocks;
  144.   /* Size of a DCT block in samples.  Always DCTSIZE for compression.
  145.    * For decompression this is the size of the output from one DCT block,
  146.    * reflecting any scaling we choose to apply during the IDCT step.
  147.    * Values of 1,2,4,8 are likely to be supported.  Note that different
  148.    * components may receive different IDCT scalings.
  149.    */
  150.   int DCT_scaled_size;
  151.   /* The downsampled dimensions are the component's actual, unpadded number
  152.    * of samples at the main buffer (preprocessing/compression interface), thus
  153.    * downsampled_width = ceil(image_width * Hi/Hmax)
  154.    * and similarly for height.  For decompression, IDCT scaling is included, so
  155.    * downsampled_width = ceil(image_width * Hi/Hmax * DCT_scaled_size/DCTSIZE)
  156.    */
  157.   JDIMENSION downsampled_width;     /* actual width in samples */
  158.   JDIMENSION downsampled_height; /* actual height in samples */
  159.   /* This flag is used only for decompression.  In cases where some of the
  160.    * components will be ignored (eg grayscale output from YCbCr image),
  161.    * we can skip most computations for the unused components.
  162.    */
  163.   boolean component_needed;    /* do we need the value of this component? */
  164.  
  165.   /* These values are computed before starting a scan of the component: */
  166.   int MCU_width;        /* number of blocks per MCU, horizontally */
  167.   int MCU_height;        /* number of blocks per MCU, vertically */
  168.   int MCU_blocks;        /* MCU_width * MCU_height */
  169.   int MCU_sample_width;        /* MCU width in samples, MCU_width*DCT_scaled_size */
  170.   int last_col_width;        /* # of non-dummy blocks across in last MCU */
  171.   int last_row_height;        /* # of non-dummy blocks down in last MCU */
  172.  
  173.   /* Private per-component storage for DCT or IDCT subsystem. */
  174.   void * dct_table;
  175. } jpeg_component_info;
  176.  
  177.  
  178. /* Known color spaces. */
  179.  
  180. typedef enum {
  181.     JCS_UNKNOWN,        /* error/unspecified */
  182.     JCS_GRAYSCALE,        /* monochrome */
  183.     JCS_RGB,        /* red/green/blue */
  184.     JCS_YCbCr,        /* Y/Cb/Cr (also known as YUV) */
  185.     JCS_CMYK,        /* C/M/Y/K */
  186.     JCS_YCCK        /* Y/Cb/Cr/K */
  187. } J_COLOR_SPACE;
  188.  
  189. /* DCT/IDCT algorithm options. */
  190.  
  191. typedef enum {
  192.     JDCT_ISLOW,        /* slow but accurate integer algorithm */
  193.     JDCT_IFAST,        /* faster, less accurate integer method */
  194.     JDCT_FLOAT        /* floating-point: accurate, fast on fast HW */
  195. } J_DCT_METHOD;
  196.  
  197. #ifndef JDCT_DEFAULT        /* may be overridden in jconfig.h */
  198. #define JDCT_DEFAULT  JDCT_ISLOW
  199. #endif
  200. #ifndef JDCT_FASTEST        /* may be overridden in jconfig.h */
  201. #define JDCT_FASTEST  JDCT_IFAST
  202. #endif
  203.  
  204. /* Dithering options for decompression. */
  205.  
  206. typedef enum {
  207.     JDITHER_NONE,        /* no dithering */
  208.     JDITHER_ORDERED,    /* simple ordered dither */
  209.     JDITHER_FS        /* Floyd-Steinberg error diffusion dither */
  210. } J_DITHER_MODE;
  211.  
  212.  
  213. /* Common fields between JPEG compression and decompression master structs. */
  214.  
  215. #define jpeg_common_fields \
  216.   struct jpeg_error_mgr * err;    /* Error handler module */\
  217.   struct jpeg_memory_mgr * mem;    /* Memory manager module */\
  218.   struct jpeg_progress_mgr * progress; /* Progress monitor, or NULL if none */\
  219.   boolean is_decompressor;    /* so common code can tell which is which */\
  220.   int global_state        /* for checking call sequence validity */
  221.  
  222. /* Routines that are to be used by both halves of the library are declared
  223.  * to receive a pointer to this structure.  There are no actual instances of
  224.  * jpeg_common_struct, only of jpeg_compress_struct and jpeg_decompress_struct.
  225.  */
  226. struct jpeg_common_struct {
  227.   jpeg_common_fields;        /* Fields common to both master struct types */
  228.   /* Additional fields follow in an actual jpeg_compress_struct or
  229.    * jpeg_decompress_struct.  All three structs must agree on these
  230.    * initial fields!  (This would be a lot cleaner in C++.)
  231.    */
  232. };
  233.  
  234. typedef struct jpeg_common_struct * j_common_ptr;
  235. typedef struct jpeg_compress_struct * j_compress_ptr;
  236. typedef struct jpeg_decompress_struct * j_decompress_ptr;
  237.  
  238.  
  239. /* Master record for a compression instance */
  240.  
  241. struct jpeg_compress_struct {
  242.   jpeg_common_fields;        /* Fields shared with jpeg_decompress_struct */
  243.  
  244.   /* Destination for compressed data */
  245.   struct jpeg_destination_mgr * dest;
  246.  
  247.   /* Description of source image --- these fields must be filled in by
  248.    * outer application before starting compression.  in_color_space must
  249.    * be correct before you can even call jpeg_set_defaults().
  250.    */
  251.  
  252.   JDIMENSION image_width;    /* input image width */
  253.   JDIMENSION image_height;    /* input image height */
  254.   int input_components;        /* # of color components in input image */
  255.   J_COLOR_SPACE in_color_space;    /* colorspace of input image */
  256.  
  257.   double input_gamma;        /* image gamma of input image */
  258.  
  259.   /* Compression parameters --- these fields must be set before calling
  260.    * jpeg_start_compress().  We recommend calling jpeg_set_defaults() to
  261.    * initialize everything to reasonable defaults, then changing anything
  262.    * the application specifically wants to change.  That way you won't get
  263.    * burnt when new parameters are added.  Also note that there are several
  264.    * helper routines to simplify changing parameters.
  265.    */
  266.  
  267.   int data_precision;        /* bits of precision in image data */
  268.  
  269.   int num_components;        /* # of color components in JPEG image */
  270.   J_COLOR_SPACE jpeg_color_space; /* colorspace of JPEG image */
  271.  
  272.   jpeg_component_info * comp_info;
  273.   /* comp_info[i] describes component that appears i'th in SOF */
  274.   
  275.   JQUANT_TBL * quant_tbl_ptrs[NUM_QUANT_TBLS];
  276.   /* ptrs to coefficient quantization tables, or NULL if not defined */
  277.   
  278.   JHUFF_TBL * dc_huff_tbl_ptrs[NUM_HUFF_TBLS];
  279.   JHUFF_TBL * ac_huff_tbl_ptrs[NUM_HUFF_TBLS];
  280.   /* ptrs to Huffman coding tables, or NULL if not defined */
  281.   
  282.   UINT8 arith_dc_L[NUM_ARITH_TBLS]; /* L values for DC arith-coding tables */
  283.   UINT8 arith_dc_U[NUM_ARITH_TBLS]; /* U values for DC arith-coding tables */
  284.   UINT8 arith_ac_K[NUM_ARITH_TBLS]; /* Kx values for AC arith-coding tables */
  285.  
  286.   boolean raw_data_in;        /* TRUE=caller supplies downsampled data */
  287.   boolean arith_code;        /* TRUE=arithmetic coding, FALSE=Huffman */
  288.   boolean interleave;        /* TRUE=interleaved output, FALSE=not */
  289.   boolean optimize_coding;    /* TRUE=optimize entropy encoding parms */
  290.   boolean CCIR601_sampling;    /* TRUE=first samples are cosited */
  291.   int smoothing_factor;        /* 1..100, or 0 for no input smoothing */
  292.   J_DCT_METHOD dct_method;    /* DCT algorithm selector */
  293.  
  294.   /* The restart interval can be specified in absolute MCUs by setting
  295.    * restart_interval, or in MCU rows by setting restart_in_rows
  296.    * (in which case the correct restart_interval will be figured
  297.    * for each scan).
  298.    */
  299.   unsigned int restart_interval; /* MCUs per restart, or 0 for no restart */
  300.   int restart_in_rows;        /* if > 0, MCU rows per restart interval */
  301.  
  302.   /* Parameters controlling emission of special markers. */
  303.  
  304.   boolean write_JFIF_header;    /* should a JFIF marker be written? */
  305.   /* These three values are not used by the JPEG code, merely copied */
  306.   /* into the JFIF APP0 marker.  density_unit can be 0 for unknown, */
  307.   /* 1 for dots/inch, or 2 for dots/cm.  Note that the pixel aspect */
  308.   /* ratio is defined by X_density/Y_density even when density_unit=0. */
  309.   UINT8 density_unit;        /* JFIF code for pixel size units */
  310.   UINT16 X_density;        /* Horizontal pixel density */
  311.   UINT16 Y_density;        /* Vertical pixel density */
  312.   boolean write_Adobe_marker;    /* should an Adobe marker be written? */
  313.   
  314.   /* State variable: index of next scanline to be written to
  315.    * jpeg_write_scanlines().  Application may use this to control its
  316.    * processing loop, e.g., "while (next_scanline < image_height)".
  317.    */
  318.  
  319.   JDIMENSION next_scanline;    /* 0 .. image_height-1  */
  320.  
  321.   /* Remaining fields are known throughout compressor, but generally
  322.    * should not be touched by a surrounding application.
  323.    */
  324.  
  325.   /*
  326.    * These fields are computed during compression startup
  327.    */
  328.   int max_h_samp_factor;    /* largest h_samp_factor */
  329.   int max_v_samp_factor;    /* largest v_samp_factor */
  330.  
  331.   JDIMENSION total_iMCU_rows;    /* # of iMCU rows to be input to coef ctlr */
  332.   /* The coefficient controller receives data in units of MCU rows as defined
  333.    * for fully interleaved scans (whether the JPEG file is interleaved or not).
  334.    * There are v_samp_factor * DCTSIZE sample rows of each component in an
  335.    * "iMCU" (interleaved MCU) row.
  336.    */
  337.   
  338.   /*
  339.    * These fields are valid during any one scan.
  340.    * They describe the components and MCUs actually appearing in the scan.
  341.    */
  342.   int comps_in_scan;        /* # of JPEG components in this scan */
  343.   jpeg_component_info * cur_comp_info[MAX_COMPS_IN_SCAN];
  344.   /* *cur_comp_info[i] describes component that appears i'th in SOS */
  345.   
  346.   JDIMENSION MCUs_per_row;    /* # of MCUs across the image */
  347.   JDIMENSION MCU_rows_in_scan;    /* # of MCU rows in the image */
  348.   
  349.   int blocks_in_MCU;        /* # of DCT blocks per MCU */
  350.   int MCU_membership[MAX_BLOCKS_IN_MCU];
  351.   /* MCU_membership[i] is index in cur_comp_info of component owning */
  352.   /* i'th block in an MCU */
  353.  
  354.   /*
  355.    * Links to compression subobjects (methods and private variables of modules)
  356.    */
  357.   struct jpeg_comp_master * master;
  358.   struct jpeg_c_main_controller * main;
  359.   struct jpeg_c_prep_controller * prep;
  360.   struct jpeg_c_coef_controller * coef;
  361.   struct jpeg_marker_writer * marker;
  362.   struct jpeg_color_converter * cconvert;
  363.   struct jpeg_downsampler * downsample;
  364.   struct jpeg_forward_dct * fdct;
  365.   struct jpeg_entropy_encoder * entropy;
  366. };
  367.  
  368.  
  369. /* Master record for a decompression instance */
  370.  
  371. struct jpeg_decompress_struct {
  372.   jpeg_common_fields;        /* Fields shared with jpeg_compress_struct */
  373.  
  374.   /* Source of compressed data */
  375.   struct jpeg_source_mgr * src;
  376.  
  377.   /* Basic description of image --- filled in by jpeg_read_header(). */
  378.   /* Application may inspect these values to decide how to process image. */
  379.  
  380.   JDIMENSION image_width;    /* nominal image width (from SOF marker) */
  381.   JDIMENSION image_height;    /* nominal image height */
  382.   int num_components;        /* # of color components in JPEG image */
  383.   J_COLOR_SPACE jpeg_color_space; /* colorspace of JPEG image */
  384.  
  385.   /* Decompression processing parameters --- these fields must be set before
  386.    * calling jpeg_start_decompress().  Note that jpeg_read_header() initializes
  387.    * them to default values.
  388.    */
  389.  
  390.   J_COLOR_SPACE out_color_space; /* colorspace for output */
  391.  
  392.   unsigned int scale_num, scale_denom; /* fraction by which to scale image */
  393.  
  394.   double output_gamma;        /* image gamma wanted in output */
  395.  
  396.   boolean raw_data_out;        /* TRUE=downsampled data wanted */
  397.  
  398.   boolean quantize_colors;    /* TRUE=colormapped output wanted */
  399.   /* the following are ignored if not quantize_colors: */
  400.   boolean two_pass_quantize;    /* TRUE=use two-pass color quantization */
  401.   J_DITHER_MODE dither_mode;    /* type of color dithering to use */
  402.   int desired_number_of_colors;    /* max number of colors to use */
  403.  
  404.   J_DCT_METHOD dct_method;    /* DCT algorithm selector */
  405.   boolean do_fancy_upsampling;    /* TRUE=apply fancy upsampling */
  406.  
  407.   /* Description of actual output image that will be returned to application.
  408.    * These fields are computed by jpeg_start_decompress().
  409.    * You can also use jpeg_calc_output_dimensions() to determine these values
  410.    * in advance of calling jpeg_start_decompress().
  411.    */
  412.  
  413.   JDIMENSION output_width;    /* scaled image width */
  414.   JDIMENSION output_height;    /* scaled image height */
  415.   int out_color_components;    /* # of color components in out_color_space */
  416.   int output_components;    /* # of color components returned */
  417.   /* output_components is 1 (a colormap index) when quantizing colors;
  418.    * otherwise it equals out_color_components.
  419.    */
  420.   int rec_outbuf_height;    /* min recommended height of scanline buffer */
  421.   /* If the buffer passed to jpeg_read_scanlines() is less than this many rows
  422.    * high, space and time will be wasted due to unnecessary data copying.
  423.    * Usually rec_outbuf_height will be 1 or 2, at most 4.
  424.    */
  425.  
  426.   /* When quantizing colors, the output colormap is described by these fields.
  427.    * The application can supply a colormap by setting colormap non-NULL before
  428.    * calling jpeg_start_decompress; otherwise a colormap is created during
  429.    * jpeg_start_decompress.
  430.    * The map has out_color_components rows and actual_number_of_colors columns.
  431.    */
  432.   int actual_number_of_colors;    /* number of entries in use */
  433.   JSAMPARRAY colormap;        /* The color map as a 2-D pixel array */
  434.  
  435.   /* State variable: index of next scaled scanline to be read from
  436.    * jpeg_read_scanlines().  Application may use this to control its
  437.    * processing loop, e.g., "while (output_scanline < output_height)".
  438.    */
  439.  
  440.   JDIMENSION output_scanline;    /* 0 .. output_height-1  */
  441.  
  442.   /* Internal JPEG parameters --- the application usually need not look at
  443.    * these fields.
  444.    */
  445.  
  446.   /* Quantization and Huffman tables are carried forward across input
  447.    * datastreams when processing abbreviated JPEG datastreams.
  448.    */
  449.  
  450.   JQUANT_TBL * quant_tbl_ptrs[NUM_QUANT_TBLS];
  451.   /* ptrs to coefficient quantization tables, or NULL if not defined */
  452.  
  453.   JHUFF_TBL * dc_huff_tbl_ptrs[NUM_HUFF_TBLS];
  454.   JHUFF_TBL * ac_huff_tbl_ptrs[NUM_HUFF_TBLS];
  455.   /* ptrs to Huffman coding tables, or NULL if not defined */
  456.  
  457.   /* These parameters are never carried across datastreams, since they
  458.    * are given in SOF/SOS markers or defined to be reset by SOI.
  459.    */
  460.  
  461.   int data_precision;        /* bits of precision in image data */
  462.  
  463.   jpeg_component_info * comp_info;
  464.   /* comp_info[i] describes component that appears i'th in SOF */
  465.  
  466.   UINT8 arith_dc_L[NUM_ARITH_TBLS]; /* L values for DC arith-coding tables */
  467.   UINT8 arith_dc_U[NUM_ARITH_TBLS]; /* U values for DC arith-coding tables */
  468.   UINT8 arith_ac_K[NUM_ARITH_TBLS]; /* Kx values for AC arith-coding tables */
  469.  
  470.   boolean arith_code;        /* TRUE=arithmetic coding, FALSE=Huffman */
  471.  
  472.   unsigned int restart_interval; /* MCUs per restart interval, or 0 for no restart */
  473.  
  474.   /* These fields record data obtained from optional markers recognized by
  475.    * the JPEG library.
  476.    */
  477.   boolean saw_JFIF_marker;    /* TRUE iff a JFIF APP0 marker was found */
  478.   /* Data copied from JFIF marker: */
  479.   UINT8 density_unit;        /* JFIF code for pixel size units */
  480.   UINT16 X_density;        /* Horizontal pixel density */
  481.   UINT16 Y_density;        /* Vertical pixel density */
  482.   boolean saw_Adobe_marker;    /* TRUE iff an Adobe APP14 marker was found */
  483.   UINT8 Adobe_transform;    /* Color transform code from Adobe marker */
  484.  
  485.   boolean CCIR601_sampling;    /* TRUE=first samples are cosited */
  486.  
  487.   /* Remaining fields are known throughout decompressor, but generally
  488.    * should not be touched by a surrounding application.
  489.    */
  490.  
  491.   /*
  492.    * These fields are computed during decompression startup
  493.    */
  494.   int max_h_samp_factor;    /* largest h_samp_factor */
  495.   int max_v_samp_factor;    /* largest v_samp_factor */
  496.  
  497.   int min_DCT_scaled_size;    /* smallest DCT_scaled_size of any component */
  498.  
  499.   JDIMENSION total_iMCU_rows;    /* # of iMCU rows to be output by coef ctlr */
  500.   /* The coefficient controller outputs data in units of MCU rows as defined
  501.    * for fully interleaved scans (whether the JPEG file is interleaved or not).
  502.    * There are v_samp_factor * DCT_scaled_size sample rows of each component
  503.    * in an "iMCU" (interleaved MCU) row.
  504.    */
  505.  
  506.   JSAMPLE * sample_range_limit; /* table for fast range-limiting */
  507.  
  508.   /*
  509.    * These fields are valid during any one scan.
  510.    * They describe the components and MCUs actually appearing in the scan.
  511.    */
  512.   int comps_in_scan;        /* # of JPEG components in this scan */
  513.   jpeg_component_info * cur_comp_info[MAX_COMPS_IN_SCAN];
  514.   /* *cur_comp_info[i] describes component that appears i'th in SOS */
  515.  
  516.   JDIMENSION MCUs_per_row;    /* # of MCUs across the image */
  517.   JDIMENSION MCU_rows_in_scan;    /* # of MCU rows in the image */
  518.  
  519.   int blocks_in_MCU;        /* # of DCT blocks per MCU */
  520.   int MCU_membership[MAX_BLOCKS_IN_MCU];
  521.   /* MCU_membership[i] is index in cur_comp_info of component owning */
  522.   /* i'th block in an MCU */
  523.  
  524.   /* This field is shared between entropy decoder and marker parser.
  525.    * It is either zero or the code of a JPEG marker that has been
  526.    * read from the data source, but has not yet been processed.
  527.    */
  528.   int unread_marker;
  529.  
  530.   /*
  531.    * Links to decompression subobjects (methods, private variables of modules)
  532.    */
  533.   struct jpeg_decomp_master * master;
  534.   struct jpeg_d_main_controller * main;
  535.   struct jpeg_d_coef_controller * coef;
  536.   struct jpeg_d_post_controller * post;
  537.   struct jpeg_marker_reader * marker;
  538.   struct jpeg_entropy_decoder * entropy;
  539.   struct jpeg_inverse_dct * idct;
  540.   struct jpeg_upsampler * upsample;
  541.   struct jpeg_color_deconverter * cconvert;
  542.   struct jpeg_color_quantizer * cquantize;
  543. };
  544.  
  545.  
  546. /* "Object" declarations for JPEG modules that may be supplied or called
  547.  * directly by the surrounding application.
  548.  * As with all objects in the JPEG library, these structs only define the
  549.  * publicly visible methods and state variables of a module.  Additional
  550.  * private fields may exist after the public ones.
  551.  */
  552.  
  553.  
  554. /* Error handler object */
  555.  
  556. struct jpeg_error_mgr {
  557.   /* Error exit handler: does not return to caller */
  558.   JMETHOD(void, error_exit, (j_common_ptr cinfo));
  559.   /* Conditionally emit a trace or warning message */
  560.   JMETHOD(void, emit_message, (j_common_ptr cinfo, int msg_level));
  561.   /* Routine that actually outputs a trace or error message */
  562.   JMETHOD(void, output_message, (j_common_ptr cinfo));
  563.   /* Format a message string for the most recent JPEG error or message */
  564.   JMETHOD(void, format_message, (j_common_ptr cinfo, char * buffer));
  565. #define JMSG_LENGTH_MAX  200    /* recommended size of format_message buffer */
  566.   /* Reset error state variables at start of a new image */
  567.   JMETHOD(void, reset_error_mgr, (j_common_ptr cinfo));
  568.   
  569.   /* The message ID code and any parameters are saved here.
  570.    * A message can have one string parameter or up to 8 int parameters.
  571.    */
  572.   int msg_code;
  573. #define JMSG_STR_PARM_MAX  80
  574.   union {
  575.     int i[8];
  576.     char s[JMSG_STR_PARM_MAX];
  577.   } msg_parm;
  578.   
  579.   /* Standard state variables for error facility */
  580.   
  581.   int trace_level;        /* max msg_level that will be displayed */
  582.   
  583.   /* For recoverable corrupt-data errors, we emit a warning message,
  584.    * but keep going unless emit_message chooses to abort.  emit_message
  585.    * should count warnings in num_warnings.  The surrounding application
  586.    * can check for bad data by seeing if num_warnings is nonzero at the
  587.    * end of processing.
  588.    */
  589.   long num_warnings;        /* number of corrupt-data warnings */
  590.  
  591.   /* These fields point to the table(s) of error message strings.
  592.    * An application can change the table pointer to switch to a different
  593.    * message list (typically, to change the language in which errors are
  594.    * reported).  Some applications may wish to add additional error codes
  595.    * that will be handled by the JPEG library error mechanism; the second
  596.    * table pointer is used for this purpose.
  597.    *
  598.    * First table includes all errors generated by JPEG library itself.
  599.    * Error code 0 is reserved for a "no such error string" message.
  600.    */
  601.   const char * const * jpeg_message_table; /* Library errors */
  602.   int last_jpeg_message;    /* Table contains strings 0..last_jpeg_message */
  603.   /* Second table can be added by application (see cjpeg/djpeg for example).
  604.    * It contains strings numbered first_addon_message..last_addon_message.
  605.    */
  606.   const char * const * addon_message_table; /* Non-library errors */
  607.   int first_addon_message;    /* code for first string in addon table */
  608.   int last_addon_message;    /* code for last string in addon table */
  609. };
  610.  
  611.  
  612. /* Progress monitor object */
  613.  
  614. struct jpeg_progress_mgr {
  615.   JMETHOD(void, progress_monitor, (j_common_ptr cinfo));
  616.  
  617.   long pass_counter;        /* work units completed in this pass */
  618.   long pass_limit;        /* total number of work units in this pass */
  619.   int completed_passes;        /* passes completed so far */
  620.   int total_passes;        /* total number of passes expected */
  621. };
  622.  
  623.  
  624. /* Data destination object for compression */
  625.  
  626. struct jpeg_destination_mgr {
  627.   JOCTET * next_output_byte;    /* => next byte to write in buffer */
  628.   size_t free_in_buffer;    /* # of byte spaces remaining in buffer */
  629.  
  630.   JMETHOD(void, init_destination, (j_compress_ptr cinfo));
  631.   JMETHOD(boolean, empty_output_buffer, (j_compress_ptr cinfo));
  632.   JMETHOD(void, term_destination, (j_compress_ptr cinfo));
  633. };
  634.  
  635.  
  636. /* Data source object for decompression */
  637.  
  638. struct jpeg_source_mgr {
  639.   const JOCTET * next_input_byte; /* => next byte to read from buffer */
  640.   size_t bytes_in_buffer;    /* # of bytes remaining in buffer */
  641.  
  642.   JMETHOD(void, init_source, (j_decompress_ptr cinfo));
  643.   JMETHOD(boolean, fill_input_buffer, (j_decompress_ptr cinfo));
  644.   JMETHOD(void, skip_input_data, (j_decompress_ptr cinfo, long num_bytes));
  645.   JMETHOD(boolean, resync_to_restart, (j_decompress_ptr cinfo));
  646.   JMETHOD(void, term_source, (j_decompress_ptr cinfo));
  647. };
  648.  
  649.  
  650. /* Memory manager object.
  651.  * Allocates "small" objects (a few K total), "large" objects (tens of K),
  652.  * and "really big" objects (virtual arrays with backing store if needed).
  653.  * The memory manager does not allow individual objects to be freed; rather,
  654.  * each created object is assigned to a pool, and whole pools can be freed
  655.  * at once.  This is faster and more convenient than remembering exactly what
  656.  * to free, especially where malloc()/free() are not too speedy.
  657.  * NB: alloc routines never return NULL.  They exit to error_exit if not
  658.  * successful.
  659.  */
  660.  
  661. #define JPOOL_PERMANENT    0    /* lasts until master record is destroyed */
  662. #define JPOOL_IMAGE    1    /* lasts until done with image/datastream */
  663. #define JPOOL_NUMPOOLS    2
  664.  
  665. typedef struct jvirt_sarray_control * jvirt_sarray_ptr;
  666. typedef struct jvirt_barray_control * jvirt_barray_ptr;
  667.  
  668.  
  669. struct jpeg_memory_mgr {
  670.   /* Method pointers */
  671.   JMETHOD(void *, alloc_small, (j_common_ptr cinfo, int pool_id,
  672.                 size_t sizeofobject));
  673.   JMETHOD(void FAR *, alloc_large, (j_common_ptr cinfo, int pool_id,
  674.                      size_t sizeofobject));
  675.   JMETHOD(JSAMPARRAY, alloc_sarray, (j_common_ptr cinfo, int pool_id,
  676.                      JDIMENSION samplesperrow,
  677.                      JDIMENSION numrows));
  678.   JMETHOD(JBLOCKARRAY, alloc_barray, (j_common_ptr cinfo, int pool_id,
  679.                       JDIMENSION blocksperrow,
  680.                       JDIMENSION numrows));
  681.   JMETHOD(jvirt_sarray_ptr, request_virt_sarray, (j_common_ptr cinfo,
  682.                           int pool_id,
  683.                           JDIMENSION samplesperrow,
  684.                           JDIMENSION numrows,
  685.                           JDIMENSION unitheight));
  686.   JMETHOD(jvirt_barray_ptr, request_virt_barray, (j_common_ptr cinfo,
  687.                           int pool_id,
  688.                           JDIMENSION blocksperrow,
  689.                           JDIMENSION numrows,
  690.                           JDIMENSION unitheight));
  691.   JMETHOD(void, realize_virt_arrays, (j_common_ptr cinfo));
  692.   JMETHOD(JSAMPARRAY, access_virt_sarray, (j_common_ptr cinfo,
  693.                        jvirt_sarray_ptr ptr,
  694.                        JDIMENSION start_row,
  695.                        boolean writable));
  696.   JMETHOD(JBLOCKARRAY, access_virt_barray, (j_common_ptr cinfo,
  697.                         jvirt_barray_ptr ptr,
  698.                         JDIMENSION start_row,
  699.                         boolean writable));
  700.   JMETHOD(void, free_pool, (j_common_ptr cinfo, int pool_id));
  701.   JMETHOD(void, self_destruct, (j_common_ptr cinfo));
  702.  
  703.   /* Limit on memory allocation for this JPEG object.  (Note that this is
  704.    * merely advisory, not a guaranteed maximum; it only affects the space
  705.    * used for virtual-array buffers.)  May be changed by outer application
  706.    * after creating the JPEG object.
  707.    */
  708.   long max_memory_to_use;
  709. };
  710.  
  711.  
  712. /* Routine signature for application-supplied marker processing methods.
  713.  * Need not pass marker code since it is stored in cinfo->unread_marker.
  714.  */
  715. typedef JMETHOD(boolean, jpeg_marker_parser_method, (j_decompress_ptr cinfo));
  716.  
  717.  
  718. /* Declarations for routines called by application.
  719.  * The JPP macro hides prototype parameters from compilers that can't cope.
  720.  * Note JPP requires double parentheses.
  721.  */
  722.  
  723. #ifdef HAVE_PROTOTYPES
  724. #define JPP(arglist)    arglist
  725. #else
  726. #define JPP(arglist)    ()
  727. #endif
  728.  
  729.  
  730. /* Short forms of external names for systems with brain-damaged linkers.
  731.  * We shorten external names to be unique in the first six letters, which
  732.  * is good enough for all known systems.
  733.  * (If your compiler itself needs names to be unique in less than 15 
  734.  * characters, you are out of luck.  Get a better compiler.)
  735.  */
  736.  
  737. #ifdef NEED_SHORT_EXTERNAL_NAMES
  738. #define jpeg_std_error        jStdError
  739. #define jpeg_create_compress    jCreaCompress
  740. #define jpeg_create_decompress    jCreaDecompress
  741. #define jpeg_destroy_compress    jDestCompress
  742. #define jpeg_destroy_decompress    jDestDecompress
  743. #define jpeg_stdio_dest        jStdDest
  744. #define jpeg_stdio_src        jStdSrc
  745. #define jpeg_set_defaults    jSetDefaults
  746. #define jpeg_set_colorspace    jSetColorspace
  747. #define jpeg_default_colorspace    jDefColorspace
  748. #define jpeg_set_quality    jSetQuality
  749. #define jpeg_set_linear_quality    jSetLQuality
  750. #define jpeg_add_quant_table    jAddQuantTable
  751. #define jpeg_quality_scaling    jQualityScaling
  752. #define jpeg_suppress_tables    jSuppressTables
  753. #define jpeg_alloc_quant_table    jAlcQTable
  754. #define jpeg_alloc_huff_table    jAlcHTable
  755. #define jpeg_start_compress    jStrtCompress
  756. #define jpeg_write_scanlines    jWrtScanlines
  757. #define jpeg_finish_compress    jFinCompress
  758. #define jpeg_write_raw_data    jWrtRawData
  759. #define jpeg_write_marker    jWrtMarker
  760. #define jpeg_write_tables    jWrtTables
  761. #define jpeg_read_header    jReadHeader
  762. #define jpeg_start_decompress    jStrtDecompress
  763. #define jpeg_read_scanlines    jReadScanlines
  764. #define jpeg_finish_decompress    jFinDecompress
  765. #define jpeg_read_raw_data    jReadRawData
  766. #define jpeg_calc_output_dimensions    jCalcDimensions
  767. #define jpeg_set_marker_processor    jSetMarker
  768. #define jpeg_abort_compress    jAbrtCompress
  769. #define jpeg_abort_decompress    jAbrtDecompress
  770. #define jpeg_abort        jAbort
  771. #define jpeg_destroy        jDestroy
  772. #define jpeg_resync_to_restart    jResyncRestart
  773. #endif /* NEED_SHORT_EXTERNAL_NAMES */
  774.  
  775.  
  776. /* Default error-management setup */
  777. EXTERN struct jpeg_error_mgr *jpeg_std_error JPP((struct jpeg_error_mgr *err));
  778.  
  779. /* Initialization and destruction of JPEG compression objects */
  780. /* NB: you must set up the error-manager BEFORE calling jpeg_create_xxx */
  781. EXTERN void jpeg_create_compress JPP((j_compress_ptr cinfo));
  782. EXTERN void jpeg_create_decompress JPP((j_decompress_ptr cinfo));
  783. EXTERN void jpeg_destroy_compress JPP((j_compress_ptr cinfo));
  784. EXTERN void jpeg_destroy_decompress JPP((j_decompress_ptr cinfo));
  785.  
  786. /* Standard data source and destination managers: stdio streams. */
  787. /* Caller is responsible for opening the file before and closing after. */
  788. EXTERN void jpeg_stdio_dest JPP((j_compress_ptr cinfo, FILE * outfile));
  789. EXTERN void jpeg_stdio_src JPP((j_decompress_ptr cinfo, FILE * infile));
  790.  
  791. /* Default parameter setup for compression */
  792. EXTERN void jpeg_set_defaults JPP((j_compress_ptr cinfo));
  793. /* Compression parameter setup aids */
  794. EXTERN void jpeg_set_colorspace JPP((j_compress_ptr cinfo,
  795.                      J_COLOR_SPACE colorspace));
  796. EXTERN void jpeg_default_colorspace JPP((j_compress_ptr cinfo));
  797. EXTERN void jpeg_set_quality JPP((j_compress_ptr cinfo, int quality,
  798.                   boolean force_baseline));
  799. EXTERN void jpeg_set_linear_quality JPP((j_compress_ptr cinfo,
  800.                      int scale_factor,
  801.                      boolean force_baseline));
  802. EXTERN void jpeg_add_quant_table JPP((j_compress_ptr cinfo, int which_tbl,
  803.                       const unsigned int *basic_table,
  804.                       int scale_factor,
  805.                       boolean force_baseline));
  806. EXTERN int jpeg_quality_scaling JPP((int quality));
  807. EXTERN void jpeg_suppress_tables JPP((j_compress_ptr cinfo,
  808.                       boolean suppress));
  809. EXTERN JQUANT_TBL * jpeg_alloc_quant_table JPP((j_common_ptr cinfo));
  810. EXTERN JHUFF_TBL * jpeg_alloc_huff_table JPP((j_common_ptr cinfo));
  811.  
  812. /* Main entry points for compression */
  813. EXTERN void jpeg_start_compress JPP((j_compress_ptr cinfo,
  814.                      boolean write_all_tables));
  815. EXTERN JDIMENSION jpeg_write_scanlines JPP((j_compress_ptr cinfo,
  816.                         JSAMPARRAY scanlines,
  817.                         JDIMENSION num_lines));
  818. EXTERN void jpeg_finish_compress JPP((j_compress_ptr cinfo));
  819.  
  820. /* Replaces jpeg_write_scanlines when writing raw downsampled data. */
  821. EXTERN JDIMENSION jpeg_write_raw_data JPP((j_compress_ptr cinfo,
  822.                        JSAMPIMAGE data,
  823.                        JDIMENSION num_lines));
  824.  
  825. /* Write a special marker.  See libjpeg.doc concerning safe usage. */
  826. EXTERN void jpeg_write_marker JPP((j_compress_ptr cinfo, int marker,
  827.                    const JOCTET *dataptr, unsigned int datalen));
  828.  
  829. /* Alternate compression function: just write an abbreviated table file */
  830. EXTERN void jpeg_write_tables JPP((j_compress_ptr cinfo));
  831.  
  832. /* Decompression startup: read start of JPEG datastream to see what's there */
  833. EXTERN int jpeg_read_header JPP((j_decompress_ptr cinfo,
  834.                  boolean require_image));
  835. /* Return value is one of: */
  836. #define JPEG_HEADER_OK        0 /* Found valid image datastream */
  837. #define JPEG_HEADER_TABLES_ONLY    1 /* Found valid table-specs-only datastream */
  838. #define JPEG_SUSPENDED        2 /* Had to suspend before end of headers */
  839. /* If you pass require_image = TRUE (normal case), you need not check for
  840.  * a TABLES_ONLY return code; an abbreviated file will cause an error exit.
  841.  * JPEG_SUSPENDED is only possible if you use a data source module that can
  842.  * give a suspension return (the stdio source module doesn't).
  843.  */
  844.  
  845. /* Main entry points for decompression */
  846. EXTERN void jpeg_start_decompress JPP((j_decompress_ptr cinfo));
  847. EXTERN JDIMENSION jpeg_read_scanlines JPP((j_decompress_ptr cinfo,
  848.                        JSAMPARRAY scanlines,
  849.                        JDIMENSION max_lines));
  850. EXTERN boolean jpeg_finish_decompress JPP((j_decompress_ptr cinfo));
  851.  
  852. /* Replaces jpeg_read_scanlines when reading raw downsampled data. */
  853. EXTERN JDIMENSION jpeg_read_raw_data JPP((j_decompress_ptr cinfo,
  854.                       JSAMPIMAGE data,
  855.                       JDIMENSION max_lines));
  856.  
  857. /* Precalculate output dimensions for current decompression parameters. */
  858. EXTERN void jpeg_calc_output_dimensions JPP((j_decompress_ptr cinfo));
  859.  
  860. /* Install a special processing method for COM or APPn markers. */
  861. EXTERN void jpeg_set_marker_processor JPP((j_decompress_ptr cinfo,
  862.                        int marker_code,
  863.                        jpeg_marker_parser_method routine));
  864.  
  865. /* If you choose to abort compression or decompression before completing
  866.  * jpeg_finish_(de)compress, then you need to clean up to release memory,
  867.  * temporary files, etc.  You can just call jpeg_destroy_(de)compress
  868.  * if you're done with the JPEG object, but if you want to clean it up and
  869.  * reuse it, call this:
  870.  */
  871. EXTERN void jpeg_abort_compress JPP((j_compress_ptr cinfo));
  872. EXTERN void jpeg_abort_decompress JPP((j_decompress_ptr cinfo));
  873.  
  874. /* Generic versions of jpeg_abort and jpeg_destroy that work on either
  875.  * flavor of JPEG object.  These may be more convenient in some places.
  876.  */
  877. EXTERN void jpeg_abort JPP((j_common_ptr cinfo));
  878. EXTERN void jpeg_destroy JPP((j_common_ptr cinfo));
  879.  
  880. /* Default restart-marker-resync procedure for use by data source modules */
  881. EXTERN boolean jpeg_resync_to_restart JPP((j_decompress_ptr cinfo));
  882.  
  883.  
  884. /* These marker codes are exported since applications and data source modules
  885.  * are likely to want to use them.
  886.  */
  887.  
  888. #define JPEG_RST0    0xD0    /* RST0 marker code */
  889. #define JPEG_EOI    0xD9    /* EOI marker code */
  890. #define JPEG_APP0    0xE0    /* APP0 marker code */
  891. #define JPEG_COM    0xFE    /* COM marker code */
  892.  
  893.  
  894. /* If we have a brain-damaged compiler that emits warnings (or worse, errors)
  895.  * for structure definitions that are never filled in, keep it quiet by
  896.  * supplying dummy definitions for the various substructures.
  897.  */
  898.  
  899. #ifdef INCOMPLETE_TYPES_BROKEN
  900. #ifndef JPEG_INTERNALS        /* will be defined in jpegint.h */
  901. struct jvirt_sarray_control { long dummy; };
  902. struct jvirt_barray_control { long dummy; };
  903. struct jpeg_comp_master { long dummy; };
  904. struct jpeg_c_main_controller { long dummy; };
  905. struct jpeg_c_prep_controller { long dummy; };
  906. struct jpeg_c_coef_controller { long dummy; };
  907. struct jpeg_marker_writer { long dummy; };
  908. struct jpeg_color_converter { long dummy; };
  909. struct jpeg_downsampler { long dummy; };
  910. struct jpeg_forward_dct { long dummy; };
  911. struct jpeg_entropy_encoder { long dummy; };
  912. struct jpeg_decomp_master { long dummy; };
  913. struct jpeg_d_main_controller { long dummy; };
  914. struct jpeg_d_coef_controller { long dummy; };
  915. struct jpeg_d_post_controller { long dummy; };
  916. struct jpeg_marker_reader { long dummy; };
  917. struct jpeg_entropy_decoder { long dummy; };
  918. struct jpeg_inverse_dct { long dummy; };
  919. struct jpeg_upsampler { long dummy; };
  920. struct jpeg_color_deconverter { long dummy; };
  921. struct jpeg_color_quantizer { long dummy; };
  922. #endif /* JPEG_INTERNALS */
  923. #endif /* INCOMPLETE_TYPES_BROKEN */
  924.  
  925.  
  926. /*
  927.  * The JPEG library modules define JPEG_INTERNALS before including this file.
  928.  * The internal structure declarations are read only when that is true.
  929.  * Applications using the library should not include jpegint.h, but may wish
  930.  * to include jerror.h.
  931.  */
  932.  
  933. #ifdef JPEG_INTERNALS
  934. #include "jpegint.h"        /* fetch private declarations */
  935. #include "jerror.h"        /* fetch error codes too */
  936. #endif
  937.  
  938. #endif /* JPEGLIB_H */
  939.